New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(action_manager): Action Manager module integration #184

Open

TsXor wants to merge 15 commits into loonghao:main from TsXor:action_manager_module_integration

TsXor commented Sep 4, 2022

Integrates https://github.com/TsXor/photoshop-ActionManager-python with minimum modification to main tree.
There's a problem: it seems that the generated code reference is not enough to document my submodule. So what should I do to add more document? By posting it in gist and attach a hyperlink?


          refactor(ActionDescriptor,ActionList,ActionReference): better type co…

9537f5f

…mmunication and completes functions in photoshop js reference

Signed-off-by: TsXor <[email protected]>

TsXor force-pushed the action_manager_module_integration branch from 92899c8 to 4461d91 Compare

September 4, 2022 16:12

Author

TsXor commented Sep 7, 2022 •

edited

Loading

welp I've corrected using flake8, but I don't know what else linter hound is using...

I did poetry run pip install flake8-black and ran flake8 again, but still no more error...

TsXor force-pushed the action_manager_module_integration branch from fe848d5 to 50c6ff3 Compare

September 7, 2022 11:34

hound bot reviewed

View reviewed changes

hound bot left a comment

Some files could not be reviewed due to errors:

"pyflakes" failed during execution due to "'FlakesChecker' object has no attr...

"pyflakes" failed during execution due to "'FlakesChecker' object has no attribute 'NAMEDEXPR'"
Run flake8 with greater verbosity to see more details

hound bot reviewed

View reviewed changes

hound bot left a comment

Some files could not be reviewed due to errors:

"pyflakes" failed during execution due to "'FlakesChecker' object has no attr...

"pyflakes" failed during execution due to "'FlakesChecker' object has no attribute 'NAMEDEXPR'"
Run flake8 with greater verbosity to see more details

TsXor force-pushed the action_manager_module_integration branch from ed6bb7e to c004a59 Compare

September 7, 2022 12:04

hound bot reviewed

View reviewed changes

hound bot left a comment

Some files could not be reviewed due to errors:

"pyflakes" failed during execution due to "'FlakesChecker' object has no attr...

"pyflakes" failed during execution due to "'FlakesChecker' object has no attribute 'NAMEDEXPR'"
Run flake8 with greater verbosity to see more details

TsXor force-pushed the action_manager_module_integration branch from c004a59 to 09680e9 Compare

September 7, 2022 12:10

hound bot reviewed

View reviewed changes

hound bot left a comment

Some files could not be reviewed due to errors:

"pyflakes" failed during execution due to "'FlakesChecker' object has no attr...

"pyflakes" failed during execution due to "'FlakesChecker' object has no attribute 'NAMEDEXPR'"
Run flake8 with greater verbosity to see more details

TsXor force-pushed the action_manager_module_integration branch from 09680e9 to 97d51a8 Compare

September 7, 2022 12:15

hound bot reviewed

View reviewed changes

hound bot left a comment

Some files could not be reviewed due to errors:

"pyflakes" failed during execution due to "'FlakesChecker' object has no attr...

"pyflakes" failed during execution due to "'FlakesChecker' object has no attribute 'NAMEDEXPR'"
Run flake8 with greater verbosity to see more details

TsXor force-pushed the action_manager_module_integration branch from 97d51a8 to 8fb9d18 Compare

September 7, 2022 12:19

hound bot reviewed

View reviewed changes

hound bot left a comment

Some files could not be reviewed due to errors:

"pyflakes" failed during execution due to "'FlakesChecker' object has no attr...

"pyflakes" failed during execution due to "'FlakesChecker' object has no attribute 'NAMEDEXPR'"
Run flake8 with greater verbosity to see more details

TsXor force-pushed the action_manager_module_integration branch from 8fb9d18 to f648c6b Compare

September 7, 2022 12:29

hound bot reviewed

View reviewed changes

hound bot left a comment

Some files could not be reviewed due to errors:

"pyflakes" failed during execution due to "'FlakesChecker' object has no attr...

"pyflakes" failed during execution due to "'FlakesChecker' object has no attribute 'NAMEDEXPR'"
Run flake8 with greater verbosity to see more details

TsXor force-pushed the action_manager_module_integration branch from f648c6b to f60b236 Compare

September 7, 2022 12:51

hound bot reviewed

View reviewed changes

hound bot left a comment

Some files could not be reviewed due to errors:

"pyflakes" failed during execution due to "'FlakesChecker' object has no attr...

"pyflakes" failed during execution due to "'FlakesChecker' object has no attribute 'NAMEDEXPR'"
Run flake8 with greater verbosity to see more details

hound bot reviewed

View reviewed changes

hound bot left a comment

Some files could not be reviewed due to errors:

"pyflakes" failed during execution due to "'FlakesChecker' object has no attr...

"pyflakes" failed during execution due to "'FlakesChecker' object has no attribute 'NAMEDEXPR'"
Run flake8 with greater verbosity to see more details

TsXor marked this pull request as draft

September 8, 2022 08:51

TsXor force-pushed the action_manager_module_integration branch from 5ecb5ab to 405f8dd Compare

September 8, 2022 09:26

TsXor marked this pull request as ready for review

September 8, 2022 09:27

TsXor force-pushed the action_manager_module_integration branch from d575363 to 3e35274 Compare

September 8, 2022 13:52

TsXor changed the title ~~Action Manager module integration~~ feat(action_manager): Action Manager module integration

TsXor added 6 commits

September 8, 2022 23:55


          refactor(Session): fix Action Manager things in session

e339e77

I may have to correct something about Action Manager and its classes: ActionDescriptor, ActionList, ActionReference. Action Manager is NOT something to describe your action palette. Action Manager actually enables low-level access into photoshop, and all things in this repo can actually be rewritten in Action Manager. You can consider an ActionDescriptor as dict, ActionList as array, ActionReference as filters for searching. So we should NOT set an INSTANCE of ActionDescriptor as an attribute of a Session and instead we should set the ActionDescriptor CLASS (the same for ActionList, ActionReference).

Signed-off-by: TsXor <[email protected]>


          feat(action_manager): Integrated my AM types and utilities

ddc651b

desc_value_types and ref_form_types defines classes which describes AM things and utils contains a shortcut for id conversion.

Nothing breaking. All AM functions are still available.

My submodule uses relative importing because absolute importing causes bigger possibility in path typos.

Signed-off-by: TsXor <[email protected]>


          feat(jprint): adds 'prefix' option to add a prefix before am keywords

b642518

For example, I advice to do 'import photoshop.api.action_manager as am'. Then jprint(prefix='am') should be helpful.

Signed-off-by: TsXor <[email protected]>


          docs(examples): change all examples which uses Action Manager to make…

520018e

… use of my submodule

In fact, why use those ****s born by ScriptListener Plug-in which is totally unreadable?

Signed-off-by: TsXor <[email protected]>


          docs(action_manager): all equipped with doc strings

37bdb4a

Signed-off-by: TsXor <[email protected]>


          fix(action_manager): patch to support py37

b2b2b0e

change patching to (try eval + except), and now run black -l 80 to avoid hound warning

There will be lots of violations in hound's eye which I cannot find out locally because hound's linter is not up to date. I will have to do some shattered commits, and for these commits, I will name them hop (hound oriented programming).

Signed-off-by: TsXor <[email protected]>


          fix(action_manager,examples): fix support for Path(AliasType) and fix…

04e9362

… import picture example

Signed-off-by: TsXor <[email protected]>

TsXor force-pushed the action_manager_module_integration branch from 3e35274 to 04e9362 Compare

September 8, 2022 15:58

Author

TsXor commented Sep 9, 2022 •

edited

Loading

https://gist.github.com/TsXor/62a46f8f2846261bba7db1cc7ff02711

Just like Action Manager, I think a HowTo is more useful for this submodule.

Author

TsXor commented Sep 10, 2022

The import error is because the server used for importing does not have photoshop installed.

This is fine for testing import. This module doesn't actaully need to do com binding on import because all these classes that inherited Photoshop in _core.py is only defined but not initialized before users of this module do anything.

However, utils.py in my submodule breaks this because it initializes a ps.Application instance on importing for typeid conversion. This will not cause error on real situations, but will make it fail the import test.

This can be tackled by not initializing an app on import and trigger the initialization when any of these functions that need an app is executed.


          fix(action_manager/utils): 1. Requires initialization of app when nee…

2712d1c

…ded instead of do it on import to pass import test. 2. Warns user when typeID collision happens. (And id2str will try to avoid giving user string that will cause collision.)

typeID collision happens when a stringID and a charID share the same name. For example, charID 'From' -> stringID 'from' and charID 'from' -> stringID 'originalAddressAttr', so 'from' is a string that will cause collision. After scanning the cpp header "PITerminology.h" and "PIStringTerminology.h", I found 3 such strings and hardcoded them into utils.py. str2id() will not automatically correct user when user gives a collision string (because no one knows what he want it to be a stringID or an charID!), but will regard that string as stringID and throw a warning. Users can follow that warning's guide to fix error and suppress that warning.

Signed-off-by: TsXor <[email protected]>

TsXor force-pushed the action_manager_module_integration branch from 53eeb27 to 2712d1c Compare

September 10, 2022 13:43

Author

TsXor commented Sep 10, 2022 •

edited

Loading

You can get typeID collision detector at gist.
It was first designed to save all the typeID mappings into pickles and free str2id() from initializing an app, but that will bring extra task on photoshop version checking, so I developed the current str2id().
Collision record doesn't need versioning because it is small, therefore have very little possibility to be not backward-compatible.

Author

TsXor commented Sep 10, 2022

Something more about charID:
charID can be converted to typeID without photoshop app, for how to do this, see str2hash and hash2str in utils.py.
You may think photoshop api can throw an error when you try to convert a non-existing charID, but the fact is that it cannot.

TsXor and others added 3 commits

September 12, 2022 13:24


          style(action_manager/js_converter): hop

9b1a39a

Signed-off-by: TsXor <[email protected]>


          chore(ci): update hound to ignore BLK100

135478c

Signed-off-by: longhao <[email protected]>


          style(action_manager/js_converter): hop

387387f

Signed-off-by: TsXor <[email protected]>

TsXor force-pushed the action_manager_module_integration branch from 232ea04 to 387387f Compare

September 12, 2022 05:26

TsXor and others added 3 commits

November 13, 2022 00:24


          Merge branch 'loonghao:main' into action_manager_module_integration

202df61


          Merge remote-tracking branch 'upstream/main' into action_manager_modu…

7d1b13a

…le_integration


          fix(action_descriptor): fix a little typo

f77694b

Signed-off-by: 23Xor <[email protected]>

TsXor force-pushed the action_manager_module_integration branch from 1a6ffd6 to f77694b Compare

December 3, 2022 06:59

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet